home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d18 / printr3.arc / D-XREF63.DOC < prev    next >
Text File  |  1991-04-28  |  18KB  |  403 lines
  1.  
  2.           Pascal Cross Referencer and Listing Formatter
  3. D-Xref60.Doc                                                      Page 1 of 8 
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.                           M Y  F A R E  S H A R E                                
  17.   ***************************  NOTICE  ******************************MFS*
  18.   *  A limited license is granted to all users of this program, to make *
  19.   *  copies of this program and distribute them to other users, on the  *
  20.   *  following conditions:                                              *
  21.   *                                                                     *
  22.   *  1. The program is not to be distributed to others in modified form *
  23.   *     (which is not easy to do unless I distribute the source code.)  *
  24.   *                                                                     *
  25.   *  2. No fee is to be charged (or any other consideration received)   *
  26.   *     for copying or distributing the program without an express      *
  27.   *     written agreement with:                                         *
  28.   *                        Dorn W. Stickle                              *
  29.   *                        909 Cactus Drive                             *
  30.   *                    Round Rock, Texas 78681                          *
  31.   *                         512-255-9126                                *
  32.   *                                                                     *
  33.   *        Copyright (c) 1985 Dorn W. Stickle Enterprises               *
  34.   *                                                                     *
  35.   *  You are encouraged to copy and share this program with other users *
  36.   *                                                                     *
  37.   *     If you are using this program and finding it of value, your     *
  38.   *         contribution ($35 suggested) will be appreciated.           *
  39.   ***********************************************************Version 6.0*
  40.                              
  41.            Enough with the advertising, lets get to the goodies!
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  (see I even fixed so that you could tear this page off and throw it away.)
  62.  
  63.           Pascal Cross Referencer and Listing Formatter
  64. D-Xref60.Doc                                                      Page 2 of 8 
  65.  
  66.  
  67. D-Xref  is a Pascal Cross Reference and Listing Formatter  Program.   It  is 
  68. extremely  useful  for Debugging Turbo Pascal programs as well as  making  a 
  69. nice looking listing.  It does not in anyway mess with the source code, (any 
  70. and all goof ups in the source code are yours, not mine).
  71.  
  72. You  can invoke D-Xref with all command implemented in the command line from 
  73. DOS or you can go to the interactive menu by just invoking D-Xref.
  74.  
  75. To  invoke  D-Xref  with all commands in the command line from  DOS  do  the 
  76. following:
  77.  
  78.      x>D-Xref (x:input file (x:output file) /[options]/[x:printer file]     
  79.              (do not type in the brackets or the parenthesis.)
  80.  
  81. where:
  82.  
  83. x              = any valid drive letter
  84. x>        = Dos Prompt
  85. x:input file   = file to be cross referenced, the drive does not have to be
  86.                  specified if it is the default
  87. x:output file  = file to write the formatted listing and cross reference to, 
  88.                  this can also be a printer such as LPT1:  or LPT2:,  but if 
  89.                  you specify a printer, be sure to put the colon on the end.
  90.  
  91. /options       = L U C H F X W P 8 N B A M D
  92.  
  93.   where:
  94.   S = Enhance the Reserved words only or Enhance both the reserved words and
  95.       the Turbo Pascal Standard Identifiers.   The default is Reserved words
  96.       only.  This  causes  the  Standard  Identifiers  to be  interpreted as 
  97.       variables.  When toggled to the  `Strd'  then the Standard Identifiers
  98.       are then not considered variables and will be enhanced the same as the
  99.       Reserved words are.
  100.   L = List the program out, default is off.
  101.   U = Underline Reserved words, default is off.
  102.   C = Capitalize Reserved words, default is off.
  103.   H = Highlight (double strike) Reserved words, default is off.
  104.   F = Format  the  output listing.   This will draw "|"  between  each 
  105.       BEGIN, CASE, REPEAT and the matching END statement default is off.
  106.   B = Numerical  and  Alphabetical listing  of  all  Functions, Procedures and Include files.
  107.   A = Alphabetical listing (only) of all  Functions,  Procedures and Include files.
  108.   M = Numerical listing (only)  of all  Functions,  Procedures and Include files.
  109.  
  110.   X = Make  a  cross   reference  listing of   all   variables,   functions, 
  111.       procedures and at the  end of the cross  reference  show  total  lines
  112.       processed,  total number functions  and  procedures,  total  different
  113.       variables,  and  total  variables  used.    When   the   functions and
  114.       procedures are crossed referenced their starting line numbers are shown
  115.       as well as any passed variables, default is off.
  116.  
  117.  
  118.           Pascal Cross Referencer and Listing Formatter
  119. D-Xref60.Doc                                                      Page 3 of 8 
  120.  
  121.  
  122.   P = will take  you to the interactive printer default  setting  menu,  for
  123.       setting the  printer codes  for your  particular printer to be able to
  124.       use the other features  (bold, underline, compressed,etc.), default is
  125.       off.
  126.   W = Make the  line width 132 characters.   You are then prompted to see if
  127.       you want compressed mode or  normal mode,  default is  normal  mode 80
  128.       characters per line.
  129.   N =  Normal  print  not compressed.   When you pick wide then  the  program 
  130.        automagically assumes compressed print.
  131.  
  132.   8 = Make the lines 8 lines per inch rather then 6 lines per inch for more
  133.       more lines on a page. Default is 6 lines per inch, 60 lines per page.
  134.  
  135. x:printer  file  =  an ascii file with your printer defaults in  it  in  the 
  136. format:
  137.                             27,71
  138.                             27,72
  139.                             27,45,49
  140.                             27,45,48
  141.                             15
  142.                             27,48
  143.                             27,50
  144.                             Epson
  145.  
  146. the lines must be exactly as shown.  The explanation for these follows:
  147.  
  148.             Turn on  Double Strike or Bold  27,71  
  149.             Turn off Double Strike or Bold  27,72
  150.             Turn on Underline               27,45,49
  151.             Turn off Underline              27,45,48
  152.             Turn on Compressed mode         15
  153.             8 Lines per Inch                27,48
  154.             6 Lines per Inch                27,50
  155.             Name of printer                 Epson
  156.  
  157. the numbers are the Ascii representation of the actual characters.  You  can 
  158. also  have D-Xref build this file for you interactively and save it to disk.  
  159. If  you have a file for your printer then you can name it D-Xref.Def and  it 
  160. will  always go out and look for that file and use it as the  default.   The 
  161. default for the program in the absence of D-Xref.Def is Epson.  
  162.  
  163. If you want to use the standard default options but use a different  printer 
  164. file  then  you  must  have both slashes in the command line  with  a  space 
  165. between them.   There must also be a space before the first slash after  the 
  166. output name.
  167.  
  168.           Pascal Cross Referencer and Listing Formatter
  169. D-Xref60.Doc                                                      Page 4 of 8 
  170.  
  171.  
  172. D  - use the program defaults or read a default file of options as  explained 
  173. below  in detail.   The file for the default file MUST be named D-Xref.Dat in 
  174. order for D-Xref to be able to find it.  Other wise it will default to what I 
  175. have set the program at.
  176.  
  177. As of this version you are also able to build a default option file and  have 
  178. it resident on the default drive.   You build this file with the options that 
  179. you  want to use turned on by placing their name on a line and an = then True 
  180. or False.  After the /D you can follow with a "\" and the path that D-Xref.Dat
  181. is on, and the program will search that path for D-Xref.Dat.
  182.  
  183.     Example :  
  184.               A>D-Xref60 MyName Lpt1 /d\Util\Format
  185.                           or
  186.               A>D-Xref60 MyName Lpt1 /dC:\Util\Format
  187.                               
  188. This will cause D-Xref61 to Search the path \Util\Format for D-Xref.Dat.
  189.  
  190. The following is all the commands that D-Xref will recognize:
  191.  
  192.                          Standard Identifiers = True/False    (Default On) ***
  193.                          Listing              = True/False    (Default On) ***
  194.                          UnderLine            = True/False
  195.                          Highlight            = True/False
  196.                          Capitalize           = True/False     (Default On) ***
  197.                          Compressed           = True/False     (Default On) ***
  198.                          Normal               = True/False
  199.                          Format               = True/False     (Default On) ***
  200.                          Reserved Words Only  = True/False
  201.                        * Both       (sort)    = True/False
  202.                        * Alphabetic (sort)    = True/False     (Default On) ***
  203.                        * Numerical  (sort)    = True/False
  204.                          8 Lines Per Inch     = True/False
  205.                          6 Lines Per Inch     = True/False     (Default On) ***
  206.                       ** Wide Print (130 c/l) = True/False     (Default On) ***
  207.                          Xref                 = True/False     (Default On) ***
  208. Notes:
  209.  
  210. *    The features Both/Alphabetic/Numerical are referring to the sorting
  211.      of the Functions Procedures and Include files.
  212.  
  213. **   The  wide  print will put 130 characters per line out regardless of 
  214.      whether you have compressed turned on or off if you specify it as True.
  215.  
  216. ***  The options with (Default) set next to them are the defaults for the
  217.      program.  You can also specify /d on the command line and the program
  218.      will default to the options shown here as default even if you do not
  219.      have the file D-Xref.Dat on your default drive.
  220.  
  221.           Pascal Cross Referencer and Listing Formatter
  222. D-Xref60.Doc                                                      Page  5 of 8 
  223.  
  224.  
  225.  
  226. Extra  Note:   Be wary in that the default file (D-Xref.Dat) is not  exactly 
  227.                the  same  as  the command line parameter input which  is  as 
  228.                follows:  
  229.              L - List
  230.                          U - Underline  Keywords
  231.                          C - Capitalize Keywords
  232.                          H - Highlight  Keywords
  233.                          F - Format the listing
  234.                          X - Cross reference the variables
  235.                          B - Numercally & Alphabeticall sort the
  236.                               Procedures, Functions & Include files.
  237.                          A - Alphabetically (only) sort the above
  238.                          M - Numerically    (only) sort the above
  239.                          N - Normal or Non-Compressed print
  240.                          W - Wide print (132 characters per line)
  241.                          8 - Print using 8 lines per inch
  242.                          S - Standard Identifier and Reserved Words are
  243.                               hightlighted and not cross-referenced.
  244.                          P - Allow you to set to your specific printer
  245.                               either  interactively or thru  a  default file.
  246.  
  247. You can invoke D-Xref with either just the input file name or with the input 
  248. file name and output file name and you will be taken to the interactive menu 
  249. for setting the other options.  You can also invoke D-Xref with out anything 
  250. and go to the interactive menu and do everything from there.
  251.  
  252. The  interactive  menu allows you to toggle ON and OFF.   Just type  in  the 
  253. letter next to the feature that you want to turn on or off.   If you type in 
  254. P  then  you will be taken to the interactive printer default setting  menu.  
  255. If  you type in W then you are prompted if you want it in  compressed  mode, 
  256. but either way the listing will be in 132 character lines.
  257.  
  258. If  you specify a file for input that isn't there then you will be  prompted 
  259. for a new file name.  If you specify a file for output that is already there 
  260. then  you  have the option of writing over the old file or specifying a  new 
  261. name.   You can press the ESC key at any time to exit the program except for 
  262. the input file name.   You must specify a valid input file name, but anytime 
  263. there  after if you hit the ESC key then the program will immediately  stop.  
  264. Be careful of this because Turbo interprets the function keys (F1 thru  F10) 
  265. as  being  Esc,  and some of the Alt-xx and Ctrl-xx key are interpreted  the 
  266. same way.
  267.  
  268.  
  269.           Pascal Cross Referencer and Listing Formatter
  270. D-Xref60.Doc                                                      Page  6 of 8 
  271.  
  272.  
  273. Within  your source code you have some options that you can turn on and  off 
  274. with  specific commands.   I have tried to come up with some that should not 
  275. interfere with most source codes.  The options are as follows:
  276.  
  277. {.List on}
  278. {.List off} these turn the listing of the program on and off.
  279.  
  280. {.Form on}
  281. {.Form off} these turn the formatting of the listing on and off.
  282.  
  283. {.High on}
  284. {.High off} these turn the Highlighting of reserved words on and off.
  285.  
  286. {.Line on}
  287. {.Line off} these turn Underlining of reserved words on and off.
  288.  
  289. {.Caps on}
  290. {.Caps off} these turn Capitalization of reserved words on and off.
  291.  
  292. {.Skip  on}  skips a portion of code including cross reference  and  listing 
  293.              until turned OFF in the MAIN source code file.
  294. {.Skip  off} resumes processing the source code this can only be turned back 
  295.              on in the MAIN source code file.
  296.  
  297. {.Page}      this causes D-Xref to start a new page.
  298.  
  299. {.Quit}     this causes D-Xref to altogether stop processing the listing and   
  300.             if  you have Xref turned on then it will do the cross  reference 
  301.             for that portion of the file that you allowed it to process.
  302.  
  303. these  options  must start in the first column of the code and must be on  a 
  304. line by theirselves.   They must also be in the exact format shown.  You can 
  305. shorten  OFF  to OF,  but everthing else must be there.   Also you  can  use 
  306. either upper or lower case or both if you want.
  307.  
  308. The  Skip option can be turned on in an include file,  but must be turn  off 
  309. and will only be recognized in the MAIN source code file.
  310.  
  311.  
  312. This program will process the main source code as well as any files that you 
  313. have specified as include files in the Main source file with the  $I feature 
  314. of Turbo Pascal.
  315.  
  316.           Pascal Cross Referencer and Listing Formatter
  317. D-Xref60.Doc                                                      Page  7 of 8 
  318.  
  319.  
  320.  
  321. In the listing you will see at the top of each page the following:
  322.  
  323. Date at Time - - Formated Listing for : program name     Page xx
  324.  
  325. Below that you will see the following:
  326.  
  327.                        Line : D  Statement
  328.  
  329.            Line      = line number of the source code.
  330.            B         = depth of the BEGINs
  331.            Statement = actual source code
  332.  
  333. If  you  have  any include files they will be indicated by a  +  before  the 
  334. number indicating the depth of the BEGINs.  Example:
  335.  
  336.                            1026 : + 1
  337.  
  338.  
  339. Just for information purposes, here are some statistics on this program:
  340.  
  341.      Number Lines in Source Code : 3619
  342.      Number Functions            :   15
  343.      Number Procedures           :   36
  344.      Number Different Variables  :  289
  345.      Total Number Variables      : 3386
  346.  
  347. This program has limitations of the following:
  348.  
  349.      Maximum Number of different variables        : 1999
  350.      Maximum Number of Procedures and Functions   :  Unlimited
  351.      Maximum Number Include files Xrefed          :  150
  352.      Maximum Variable Name Length stored          :   32
  353.      Maximum Input Line Length                    :  255
  354.  
  355. This program requires 128 K to run. I have tested and run it on the following:
  356.  
  357.      IBM PC1   64K mother board       IBM PC2    256K mother board
  358.      IBM XT      IBM AT
  359.      Tandy 1200 HD                    Compaqs
  360.  
  361. I have also tested it under DOS 2.0,  2.1,  and 3.0.  It appears to work for 
  362. me,  hope it does for you.   If you have any questions, comments or concerns 
  363. regarding this program then you can write to me at:
  364.  
  365.                          Dorn W. Stickle
  366.                          909 Cactus Dr.
  367.                      Round Rock, Texas 78681
  368.  
  369.  
  370.           Pascal Cross Referencer and Listing Formatter
  371. D-Xref60.Doc                                                      Page  8 of 8 
  372.  
  373.  
  374.                            Disclaimer
  375.  
  376. This program is licensed "AS IS' without any warranty as to its performance, 
  377. accuracy,  or freedom from error, or as to any results generated through its 
  378. use,    including,   without   limitation,   any   implied   warranties   or 
  379. merchantability  or  of fitness for a particular purpose.   You  assume  the 
  380. entire  risk  as to the results and performance of the program.   I  do  not 
  381. warrant  that  the  program will meet your requirements or  operate  without 
  382. interruption  or  error.   In plain English,  if it goofs up  that  is  your 
  383. problem.   What do you expect for $35.00 (if you sent in your $35.00 that is 
  384. otherwise  you  can't expect much for free anyway).   I will keep a  mailing 
  385. list of all contributing persons for future updates, (not for advertising, as 
  386. I am just me not a conglomerate).
  387.  
  388. Any  complaints  (with MY program??????) or compliments  (expected)  will  be 
  389. appreciated.   If  you can think of anything else that you would like to  see 
  390. then feel free to contact me and we can discuss it.
  391.  
  392.  
  393.                                Have a Good Day!
  394.   
  395.                                     Dorn..........
  396.   
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.